home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / trac_099.zip / TRACKER.DOC < prev    next >
Text File  |  1993-01-14  |  18KB  |  401 lines
  1.                  TRACKER - A Software Development Tracking Tool
  2.  
  3.                           Version .99 BETA
  4.  
  5.                Copyright (c) January 1993 - Paul Beverly    
  6.                            (803)735-6059
  7.                           fidonet 1:376/32
  8.  
  9. HISTORY of TRACKER
  10. I have been working on a massive OS/2 project for about three years now.
  11. There have been times when there were up to 50 people working on this
  12. project in 2 states. The last estimate was that there are over 10 million
  13. lines of code for this product. That estimate was made over a year ago.
  14. As testing got into full swing we started have massive amounts of 
  15. discrepancies writtin up. One person attempted to keep up with it all. It
  16. was impossible. So one day I was in a discussion in which we we wondering
  17. about a way in which to TRACK our project. It was decided that DB/2 was
  18. the answer. The problem was that a non-technical person was doing the
  19. tracking and we didn't feel Query Manager in itself was the way to go. The
  20. next day I began writing TRACKER. 
  21.  
  22. What can TRACKER do for you?
  23.     Tracker is design to monitor large software development projects.
  24.     It allows to see quickly who is working on what piece, when they
  25.     were assigned the task, when it is due to be completed, and when
  26.     it is actually completed. 
  27.     
  28.     Attach memos to individual task.
  29.     
  30.     Monitor mulitple projects in a single database.
  31.     
  32.     Maintain a list of Clients which list contacts, Product, Version, and
  33.     more. 
  34.     
  35.     Print reports, Assignment List for individuals, Assignment list which
  36.     shows all assignments by category, Open report which shows what task
  37.     all currently open, Closed report which shows what has been closed 
  38.     within a given date range. 
  39.     
  40. IF ALL OF THE FOLLOWING ARE TRUE, YOU CAN USE TRACKER!
  41. 1. You must have OS/2 1.2 or higher.
  42. 2. You must have the Database Services from OS/2 EE installed.
  43. 3. You must have the ability to create a database in Query Manager 
  44.    and the needed tables to run Tracker.
  45.    
  46. Keep in mind, this is a BETA system, installation is not fun. 
  47.  
  48. This is the 2nd and final Beta for Tracker 1.0. A lot of enhancements have
  49. been made since the previous Beta of Tracker. The fixes and enhancements 
  50. will be listed next, as I can remember them, there are too many for me
  51. to remember. The basic difference between the .99 version and the 1.0 will
  52. be that I will have a real .DOC file that really looks half way decent. I
  53. will also include a REAL installation program that will install the database
  54. for you.
  55.  
  56. Release        Fix/Enhancement
  57. -------        ----------------------------------------------------
  58. .090           First Release
  59. .99            Added Memo facility which allows mutiple memos to
  60.                 be attached to a discrepancy.
  61. .99            Added Client Tracker
  62. .99            Added support table descriptions. This gives more meaning
  63.                 to printed output.
  64. .99            Added Summary screen so you can view what you are about to
  65.                 print before you actually print. 
  66. .99            Changed Bitmap to something smaller that loads faster, I
  67.                 still don't like it.
  68. .99            Numerous fixes!                
  69. .99            There have been datbase changes. Are you need to do is add
  70.                what is missing. You don't have to start your database from
  71.                scratch. If you used Tracker 0.090, check your database tables
  72.                against what I have defined here before trying to use this 
  73.                version. If you don't have it, add it!
  74.  
  75.                                                                  
  76. I promise nothing with this software. If you lose data, OH WELL. If
  77. it crashes, again, OH WELL. The word BETA is the KEY WORD here. 
  78. It was developed un OS/2 1.3 with the IBM C/2 Compiler. In theory
  79. it should work just fine on OS/2 2.0. 
  80.  
  81. If you have any comments or questions I may be reached via FidoNet
  82. at 1:376/32 or you are welcome to call me at (803)735-6059. If you
  83. call and I do not answer, you may leave me a message. I WILL NOT
  84. return calls. You may leave a FidoNet address in the message and I
  85. will answer your concerns in that fashion.
  86.  
  87. While TRACKER is still in a BETA mode, I will distribute it as 
  88. Public Domain. Once I go to v1.0 I expect any who use it to pay 
  89. for it. It will be released as some form of ShareWare.
  90.  
  91. This program was started because their was a need. A need to be able
  92. to track software development. The project I am working on is huge
  93. and we have serveral people from several areas working on it. The 
  94. day we started using TRACKER we had over 700 entries in it. In
  95. a 3 week period it has grown to well over a 1000. We have also
  96. started tracking a second product. 
  97.  
  98. What can TRACKER do for you. First, it is meant for Software Development
  99. companies, not individual users. No individual user would ever want it, 
  100. unless you are a developer and would like to keep up with yourself. 
  101. TRACKER allows you to keep up with discrepancies which are discovered
  102. in the development stage. I have attempted to NOT make it TOO specific
  103. to the particular project I am working on. Should you find it promising
  104. for you but find it somehow limited let me know. We can discuss what
  105. needs to be done in order for you to use it for your situation.
  106.  
  107. This being the first BETA of TRACKER, there is only enough  
  108. documentation to get you started. All you are going to get
  109. is the layout of the database and a brief description of the fields.
  110.  
  111. If you do not have the OS/2 Database Services loaded on your machine
  112. you may as well stop right now. You cannot run TRACKER without it.
  113. If you are not familiar with Query Manager, STOP and find someone who is.
  114.  
  115.  
  116. To get started:
  117.  
  118. Bring up Query Manager and Create a new database. It must be called 
  119. TRACKER.
  120.  
  121. Once it is created go to Tables and Views of the new database. Following
  122. is a list of tables which need to be created and what fields should
  123. be in each table.
  124.  
  125. On the tables which mention SCREEN FIELD, this is referring to the
  126. actual TRACKER screens. These are dropdowns. The program loads the
  127. dropdown from these tables.
  128.  
  129. DATABASE
  130. -----------------------------------------------------------------------
  131. TABLE        = ACCESS
  132. DESCRIPTION  = FUTURE USE - Will be used with RDS for security.
  133.  
  134. Column Name         Type                  Length    Attributes
  135. ACCESS              Character (Fixed)     2         Data required, Text
  136. USER_ID             Character (Fixed)     7         Data required, Text
  137. PASSWORD            Character (Fixed)     7         Text
  138. -------------------------------------------------------------------------
  139. TABLE        = DATE_RANGE
  140. DESCRIPTION  = Used if you want to create your own Queries and Reports
  141.                through Query Manager. 
  142.  
  143. Column Name         Type                  Length    Attributes
  144. BEG_DATE            Date                            Data required
  145. END_DATE            Date                            Data required
  146. ------------------------------------------------------------------------
  147. TABLE        = LOB     
  148. SCREEN FIELD = Line of Business
  149. DESCRIPTION  = SUPPORT TABLE for the LOB (Line of Business) DROPDOWN.
  150.                Value this table with whatever codes you want to 
  151.                represent your lines of business.
  152.  
  153. Column              Type                   Length    Attributes
  154. LOB_TXT             Character (Fixed)      10        Text
  155. PRODUCT_CODE        Character (Fixed)      5         Text
  156. LOB_NAME            Character (Fixed)      25        Text
  157. ------------------------------------------------------------------------
  158. TABLE        = PRODUCT_CODE
  159. SCREEN FIELD = Product
  160. DESCRIPTION  = SUPPORT TABLE to place the codes for your different 
  161.                products
  162.  
  163. Column Name         Type                   Length    Attributes
  164. PRODUCT             Character (Fixed)      5         Data Required, Text
  165. PRODUCT_NAME        Character (Fixed)      25        Text
  166. ------------------------------------------------------------------------
  167. TABLE        = STATUS
  168. SCREEN FIELD = Status
  169. DESCRIPTION  = SUPPORT TABLE to place your status codes.
  170.  
  171. Column Name         Type                   Length    Attributes
  172. STATUS_TXT          Character (Fixed)      10        Text
  173. ------------------------------------------------------------------------
  174.  
  175. ------------------------------------------------------------------------
  176. TABLE        = TRACKER_INFO
  177. DESCRIPTION  = Where TRACKER stores all its data.
  178.  
  179. Column Name         Type                   Length    Attributes
  180. SI_TYPE             Character (Fixed)      4         Data required, Text
  181. SI_NUMBER           Character (Fixed)      5         Data required, Text
  182. PRIORITY            Character (Fixed)      2         Data required, Text
  183. LOB                 Character (Fixed)      3         Data required, Text
  184. STATUS              Character (Fixed)      20        Data required, Text
  185. COMMENTS            Character (Fixed)      120       Data required, Text
  186. ECD                 Date                        
  187. ASN_DATE            Date
  188. CLOSE_DATE          Date
  189. LAST_UPDATE         System Date and Time
  190. PROGRAMMER          Character (Fixed)      25        Text
  191. ITEM                Small Integer 
  192. PRODUCT_CODE        Character (Fixed)      5         Text
  193. LOCKED              Character (Fixed)      7         Text
  194. -----------------------------------------------------------------------
  195. TABLE        = TYPE
  196. SCREEN FIELD = Discrepancy type
  197. DESCRIPTION  = SUPPORT TABLE for Type of discrepancy
  198.  
  199. Column Name         Type                   Length     Attributes
  200. TYPE_TXT            Character (Fixed)      Length     Text
  201. ------------------------------------------------------------------------
  202.  
  203. ------------------------------------------------------------------------
  204. TABLE        = TRACKER_MEMO
  205. DESCRIPTION  = Memo information is stored here.
  206.  
  207. Column Name         Type                   Length     Attributes
  208. SI_TYPE             Character (Fixed)      4          Text
  209. SI_NUMBER           Character (Fixed)      5          Text
  210. ITEM                Small Integer        
  211. NAME_TO             Character (Fixed)      25         Text
  212. NAME_FROM           Character (Fixed)      25         Text
  213. SUBJECT             Character (Fixed)      25         Text
  214. LAST_UPDATE         System Date and Time
  215. MEMO_DATE           Date
  216. MEMO_TEXT           Character (Variable)   3000       Text
  217. MEMO_ITEM           Small Integer
  218. PRODUCT_CODE        Character (Fixed)      5          Text
  219. LOCKED              Character (Fixed)      7          Text
  220. ------------------------------------------------------------------------
  221.  
  222. ------------------------------------------------------------------------
  223. TABLE        = CLIENT_INFORMATION
  224. DESCRIPTION  = Where Client information is stored.
  225.  
  226. Column Name         Type                   Length     Attributes
  227. CLIENT_NUMBER       Character (Fixed)      20         Data required, Text
  228. STREET_ADDRESS      Character (Fixed)      60         Text
  229. STREET_ADDRESS2     Character (Fixed)      60         Text
  230. CITY                Character (Fixed)      30         Text
  231. STATE               Character (Fixed)      2          Text
  232. CLIENT_NAME         Character (Fixed)      60         Text
  233. PRIMARY_CONTACT     Character (Fixed)      60         Text
  234. ALTERNATE_CONTACT   Character (Fixed)      60         Text
  235. PRODUCT_ID          Character (Fixed)      30         Text
  236. PRODUCT_VERSION     Character (Fixed)      10         Text
  237. BRANCH_MANAGER      Character (Fixed)      60         Text
  238. ACCOUNT_REP         Character (Fixed)      60         Text
  239. COUNTRY             Character (Fixed)      30         Text
  240. PHONE               Character (Fixed)      30         Text
  241. FAX                 Character (Fixed)      30         Text
  242. ZIP_CODE            Character (Fixed)      10         Text
  243. LOCKED              Character (Fixed)      7          Text
  244. -------------------------------------------------------------------------
  245.  
  246. You will find a TRACKER.INI file in the .ZIP file. It simply contains 
  247. the default PRODUCT which will show up in the PRODUCT field. You
  248. edit this file and enter in the PRODUCT CODE which you are likely
  249. to be working with most. Only one entry is allowed in this file.
  250.  
  251. You now need to BIND the program to database.
  252. From the OS/2 Command line type:
  253. SQLBIND TRACKER.BND TRACKER /FISO
  254.  
  255. If you created your database tables correctly you should receive no
  256. errors.
  257.  
  258. If you run TRACKER from PM/WPS make sure your Working Directory is
  259. pointing to where your TRACKER.INI and STRINGS.DLL are located.
  260.  
  261. You can now attempt to execute TRACKER. I will attempt to explain the
  262. screens at this point. I would advise having them up so you will
  263. see what I am talking about.
  264.  
  265. TRACKER DATA - SCREEN
  266. This is the main screen when you manipulate the data.
  267.  
  268. Product   
  269. This must always be valued. I recommend a code which contains a Product 
  270. code and version number. WP50 would mean Word Perfect 5.0
  271.  
  272. Discrepancy type 
  273. The type discrepancy you are tracking. It could be edit for edit errors 
  274. under Word Perfect. It could be Print for printing problems. 
  275.  
  276. Discrepancy number  
  277. The number of the discrepancy.
  278.  
  279. Priority -  The priority of the discrepancy. 
  280.  
  281. Line of business 
  282. If you track different types of code this is where you would make the 
  283. difference. Codes could be WORD for Word Processing or DATA for database.
  284.  
  285. Current Status 
  286. This is where you show the current status of the item. For example: 
  287. OPEN CLOSED TEST
  288.  
  289. Comments  
  290. Free form. It is scrollable and you have 120 characters.
  291.  
  292. Resource 
  293. The programmer assigned to the task or person assigned to test it.
  294. It says to use last name only, this isn't required.
  295.  
  296. Date Assigned 
  297. Date you assign it to a resource.
  298.  
  299. ECD Date 
  300. Estimated Completion Date. When resource plans on finishing task.
  301.  
  302. Close Date - Date Item is closed.
  303.  
  304. The listbox is a typical listbox. Once information is entered it may 
  305. be added to the listbox. It is also saved to the database at this time.
  306. Double clicking on an item in the listbox will bring it up to the fields
  307. and you may then manipulate the data and then CHANGE it. 
  308.  
  309. There are two CLEAR buttons. The one next to the listbox will CLEAR the
  310. listbox. The one at the bottom will CLEAR the entry fields, except Product.
  311.  
  312. SEARCH
  313. As mentioned before, Product must always be valued. You may SEARCH with 
  314. nothing else valued and it will bring up everything for that Product. 
  315. You can also add more information in which to SEARCH for. The more you
  316. provide the less the SEARCH will find. Which is really what you want.
  317. The following fields can be used with the SEARCH; Discrepancy type, 
  318. Discrepancy number, Priority, Line of Business, Current Status, Resource.
  319. Any combination of the above will work as long as there is valid data.
  320.  
  321. HINT
  322. All information should be entered in CAPS. I will eventually either force
  323. CAPS LOCK on or will perform an edit to convert the field to CAPS. Comments
  324. is the exception here since it is not used for any searches.
  325.  
  326. Search dates
  327. The subpanel is so you can add dates to you search. You will find three
  328. check boxes here. If you use this screen you must enter both dates. You
  329. may check more than one box at a time. If you check the Date Assigned box
  330. and enter in the dates of 10-01-1992 and 10-31-1992 and perform a SEARCH
  331. you will then SEARCH for all items assigned within the given date range.
  332. This will stay this way until you go back in and change it or CLEAR it.
  333.  
  334. Memos
  335. FUTURE USE - This will eventually allow you to enter Memos and attach
  336. them to whatever is highlighted in the listbox. You would then be able
  337. to print them out.
  338.  
  339.  
  340.  
  341. REPORT GENERATOR - SCREEN
  342.  
  343. Simply Prints out reports. The Search information works just like
  344. the SEARCH on TRACKER DATA. If you leave them all blank, then everything
  345. gets printed. The more information you enter, the smaller the report.
  346.  
  347. The Beginning and Ending dates are only valid when printing a Closure Report
  348. and they are required in this situation.
  349.  
  350. The PRINT function works. That is all I will say. I am far from satisfied
  351. with it. It is slow and you can't use the system while it is printing. BUT
  352. IT WORKS!  <GRIN>
  353.  
  354.  
  355.  
  356. REPORT SUMMARY - Subpanel
  357. FUTURE USE
  358. When going here it will simply load a listbox with everything that would
  359. be printed if you were to hit PRINT. So you can browse before printing.
  360.  
  361.  
  362.  
  363.  
  364.  
  365. PROBLEMS - Yes there are problems!
  366.  
  367. - Entering data in mixed case is a problem. If you enter it lowercase
  368.   and search on it in uppercase, you aren't going to find it. I will
  369.   fix this one way or the other.
  370.   
  371. - Print function, as mentioned above, it is slow and the system is hung
  372.   until it is finished. I have never played with printing in PM, and 
  373.   I did not have fun doing this. Howver, it works.
  374.   
  375. If you find problems, LET ME KNOW!
  376.  
  377.  
  378.  
  379. Personal Requirements for release of 1.0 Version
  380.  
  381. - Real User Documentation and Installation Procedures
  382.  
  383. - An installation program to automatically do installation of Database.
  384.  
  385.  
  386.  
  387. ENHANCEMENTS for the Future
  388.  
  389. - Set focus to the logical field as some functions. Such as ADD, CHANGE,
  390.   or DELETE.
  391.   
  392. - Icon and Bitmap. They look like crap. I am no artist and this is not real
  393.   high on my priority list.
  394.  
  395. - Add Remote Data Services capibility, along with this will come security.
  396.  
  397. - There is a Tools menu, it is there just to be there. It will function 
  398.   someday.
  399.   
  400. - Add PM Help Facility. 
  401.